<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: plugin_t Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classplugin__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">plugin_t Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A plugin is a module in the plugins subdirectory that can perform an action asked by the user. </p>
<p>(usually via pressing a hotkey) </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a20d66527d2ef34494831e288d49581e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20d66527d2ef34494831e288d49581e5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#a20d66527d2ef34494831e288d49581e5">version</a></td></tr>
<tr class="memdesc:a20d66527d2ef34494831e288d49581e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be equal to <a class="el" href="idp_8hpp.html#af4b4e4966302754b758c8cc16f964a15" title="The interface version number. ">IDP_INTERFACE_VERSION</a>. <br /></td></tr>
<tr class="separator:a20d66527d2ef34494831e288d49581e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42ce3b5fcda2b4835a92a8c6f965b995"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42ce3b5fcda2b4835a92a8c6f965b995"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#a42ce3b5fcda2b4835a92a8c6f965b995">flags</a></td></tr>
<tr class="memdesc:a42ce3b5fcda2b4835a92a8c6f965b995"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group___p_l_u_g_i_n__.html">Plugin features</a> <br /></td></tr>
<tr class="separator:a42ce3b5fcda2b4835a92a8c6f965b995"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af28ff1f503d576299d7c1b0aa42220b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af28ff1f503d576299d7c1b0aa42220b2"></a>
int(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#af28ff1f503d576299d7c1b0aa42220b2">init</a> )(void)</td></tr>
<tr class="memdesc:af28ff1f503d576299d7c1b0aa42220b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize plugin - returns <a class="el" href="group___p_l_u_g_i_n___i_n_i_t.html">Plugin initialization codes</a>. <br /></td></tr>
<tr class="separator:af28ff1f503d576299d7c1b0aa42220b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4d2d0e04ecb20be03ee4a2952cb3634"><td class="memItemLeft" align="right" valign="top">void(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#ae4d2d0e04ecb20be03ee4a2952cb3634">term</a> )(void)</td></tr>
<tr class="memdesc:ae4d2d0e04ecb20be03ee4a2952cb3634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminate plugin.  <a href="#ae4d2d0e04ecb20be03ee4a2952cb3634">More...</a><br /></td></tr>
<tr class="separator:ae4d2d0e04ecb20be03ee4a2952cb3634"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefd33d9f9dabe6d58f78589ea56d1c57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefd33d9f9dabe6d58f78589ea56d1c57"></a>
bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#aefd33d9f9dabe6d58f78589ea56d1c57">run</a> )(size_t arg)</td></tr>
<tr class="memdesc:aefd33d9f9dabe6d58f78589ea56d1c57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invoke plugin. <br /></td></tr>
<tr class="separator:aefd33d9f9dabe6d58f78589ea56d1c57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65c40e52a893614e2882a9c3269c61ba"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#a65c40e52a893614e2882a9c3269c61ba">comment</a></td></tr>
<tr class="memdesc:a65c40e52a893614e2882a9c3269c61ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Long comment about the plugin.  <a href="#a65c40e52a893614e2882a9c3269c61ba">More...</a><br /></td></tr>
<tr class="separator:a65c40e52a893614e2882a9c3269c61ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27b238f6e884635e1a82a23ed2c5e9e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27b238f6e884635e1a82a23ed2c5e9e9"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#a27b238f6e884635e1a82a23ed2c5e9e9">help</a></td></tr>
<tr class="memdesc:a27b238f6e884635e1a82a23ed2c5e9e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiline help about the plugin. <br /></td></tr>
<tr class="separator:a27b238f6e884635e1a82a23ed2c5e9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8fce6087c72ac53396c3bad77f7553"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae8fce6087c72ac53396c3bad77f7553"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#aae8fce6087c72ac53396c3bad77f7553">wanted_name</a></td></tr>
<tr class="memdesc:aae8fce6087c72ac53396c3bad77f7553"><td class="mdescLeft">&#160;</td><td class="mdescRight">The preferred short name of the plugin. <br /></td></tr>
<tr class="separator:aae8fce6087c72ac53396c3bad77f7553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a316e4fc3c37865976e7c56141be8efc6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a316e4fc3c37865976e7c56141be8efc6"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classplugin__t.html#a316e4fc3c37865976e7c56141be8efc6">wanted_hotkey</a></td></tr>
<tr class="memdesc:a316e4fc3c37865976e7c56141be8efc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The preferred hotkey to run the plugin. <br /></td></tr>
<tr class="separator:a316e4fc3c37865976e7c56141be8efc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ae4d2d0e04ecb20be03ee4a2952cb3634"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * plugin_t::term) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Terminate plugin. </p>
<p>This function will be called when the plugin is unloaded. May be NULL. </p>

</div>
</div>
<a class="anchor" id="a65c40e52a893614e2882a9c3269c61ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* plugin_t::comment</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Long comment about the plugin. </p>
<p>it could appear in the status line or as a hint </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="loader_8hpp.html">loader.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
